using Aurora.EventBus.Sources;

namespace Aurora.EventBus.Storage;

/// <summary>
/// 事件源存储器
/// </summary>
/// <remarks>
/// <para>顾名思义，这里指的是事件消息存储中心，提供读写能力</para>
/// <para>默认实现为内存中的 <see cref="System.Threading.Channels.Channel"/>，可自由更换存储介质，如 Kafka，SQL Server 等</para>
/// </remarks>
public interface IEventSourceStorage
{
    /// <summary>
    /// 将事件源写入存储器
    /// </summary>
    /// <param name="event">事件源对象 </param>
    /// <param name="cancellationToken"> 取消任务 Token </param>
    /// <returns><see cref="ValueTask"/></returns>
    ValueTask WriteAsync(IEventSource @event, CancellationToken cancellationToken);


    /// <summary>
    /// 从存储器中读取一条事件源
    /// </summary>
    /// <param name="cancellationToken">取消任务 Token</param>
    /// <returns>事件源对象</returns>
    ValueTask<IEventSource> ReadAsync(CancellationToken cancellationToken);
}